Payment Methods Biz API

(0 reviews)

POST-paymentMethod v4r1 (Digital to SF)

CASE 1 Unitary Test

Create Payment Method in SF

URL

http://[localhost]:[port]/tmf-api/paymentMethods/v4r1/PR/paymentMethod

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR, CR etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	N

Request

{
   "@baseType": "PaymentMethod",
   "@type": "tokenizedCard",
   "name": "TokenizedCard",
    "account": [
        {
            "id": "31516278-31514752",
            "@type": "BillingAccount"
        }
    ],
    "token": "cGF5bWVudG1ldGhvZF9jY181a25obmtzZg",
    "characteristics": [
       {
        "name": "MSISDN",
        "value": "12401231232",
       },
       {
          "name": "paymentGatewayType ",
          "value": "BrainTreeToken"
        },
        {
            "name": "channel",
            "value": "Digital"
        },
        {
            "name": "restrictOrder",
            "valueType": "Boolean",
            "value": true
        }
    ]
}

Definitions

Each of the request parameters is detailed.

name	type	description	required	possible values
token	string	Braintree token	Y	cGF5bWVudG1ldGhvZF9jY19i
name	string	name of payment method	Y	TokenizedCard
account	array		Y
account.id	string	Value of Billing Account Number Conditional mandatory. either Billing Account Number or MSISDN should be passed	Y*	BANXXXX-CANYYY
account.@type	string	type of account.here it is Billing Account	N	BillingAccount
characteristics	array	A list of characteristics. Describes the characteristic of a billing account user.	Y*
characteristics.name	string	Name of the characteristics	Y	BrainTreeToken, Digital/IVR
characteristics.value	string	value of the characteristics	Y	BrainTreeToken, Digital/IVR
characteristics.valueType	string	Value type of the characteristics	Y	BrainTreeToken, Digital/IVR
@type	string	When sub-classing, this defines the sub-class entity name	N	tokenizedCard
@basetype	string	When sub-classing, this defines the sub-class entity name	N	PaymentMethod

Characteristic

name	type	description	required	possible values
MSISDN	string	customer's MSISDN	Y	12401231232
paymentGatewayType	string	Braintree token	Y	BrainTreeToken
channel	string	represents the channel from which the request was received	Y	Digital
restrictOrder	string	represents the flag to retrict order or not	N	true

Response

201 created:

{
    "description"- "payment method create request received"
}

Definitions

Each of the request parameters is detailed.

name	type	description	required	possible values
description	string	Acknowledges the create payment method request	N	"payment method create request received"

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "Bad Request",
      "description" : "The request is not formed properly"
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the tarPOST resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the tarPOST resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "Resource not Found",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/payment"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /payment for Business Id: xxxx not implemented"
    }]
  }

Reviews